assemble-fs

assemble-fs

Assemble plugin to add methods to assemble for working with the file system, like src, dest, copy and symlink.

Install

Install with npm:

$ npm install assemble-fs --save

This is an assemble core plugin, you probably won't need to use this directly.

Usage

var assemble = require('assemble');

// create your application and add the plugin
var app = assemble()
  .use(require('assemble-fs'))

// now you can use `src` and `dest`
app.src(['foo/*.hbs'])
  .pipe(app.dest('site/'))

History

v0.3.0

• breaking change! plugin is wrapped in a function that now be called when registered. e.g. fs(). This is to be consistent with assemble's plugin guidelines, and allows the plugin to be auto-loaded following the same format as other plugins.
• rename files array to streamFiles
• adds onStream middleware handler to src
• adds preWrite middleware handler to dest

Related projects

You might also be interested in these projects:

• assemble-loader: Assemble plugin (^0.6.0) for loading globs of views onto custom view collections. Also works with… more | homepage
• assemble-render-file: Assemble plugin for rendering views in a vinyl pipeline. | homepage
• assemble-streams: Assemble pipeline plugin for pushing a view collection into a vinyl stream. | homepage
• assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
• generate: Fast, composable, highly extendable project generator with a user-friendly and expressive API. | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb, v0.9.0, on April 20, 2016.